home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #1 / Amiga Plus CD - 2000 - No. 1.iso / Tools / Text / Edit / GoldED-Demo / installdata / golded / developer / api / autodoc / apilib.doc
Encoding:
Text File  |  1999-12-03  |  3.0 KB  |  112 lines
  1. TABLE OF CONTENTS
  2.  
  3. apilib.library/APIMountClient
  4. apilib.library/APICloseClient
  5. apilib.library/APIBriefClient
  6. apilib.library/APIFree
  7.  
  8. apilib.library/APIMountClient             apilib.library/APIMountClient
  9.  
  10.     NAME
  11.         APIMountClient - start client
  12.  
  13.     SYNOPSIS
  14.         description = APIMountClient(apiMsg, args)
  15.  
  16.         struct APIClient *description = APIMountClient(struct APIMessage *, char *)
  17.                D0                                                  A0            A1
  18.     FUNCTION
  19.         This function is called by the host application once for each of its
  20.         instances (e.g. windows) interested in using the client. The client
  21.         is expected to return a client description (may include an area
  22.         request) or NULL to signal an error. The client description is passed
  23.         back to the client as "handle" during all subsequent client calls.
  24.  
  25.     INPUTS
  26.         apiMsg  - API message
  27.         args    - additional arguments or NULL
  28.  
  29.     RESULTS
  30.         client description or NULL
  31.  
  32.     SEE ALSO
  33.  
  34.     BUGS
  35.  
  36. apilib.library/APICloseClient             apilib.library/APICloseClient
  37.  
  38.     NAME
  39.         APICloseClient - Announce removal of an instance using the client
  40.  
  41.     SYNOPSIS
  42.         APICloseClient(handle, apiMsg)
  43.  
  44.         void CloseClient(struct APIClient *, struct APIMessage *)
  45.                 D0                  A0                   A1
  46.  
  47.     FUNCTION
  48.         This function is called by the host application if a host instance
  49.         (e.g. a window) using the client is terminated. The client is supposed
  50.         to free ressources related to that instance.
  51.  
  52.     INPUTS
  53.         handle - handle obtained by APIMountClient()
  54.         apiMsg - API message
  55.  
  56.     RESULTS
  57.  
  58.     SEE ALSO
  59.         APIMountClient
  60.  
  61.     BUGS
  62.  
  63. apilib.library/APIBriefClient             apilib.library/APIBriefClient
  64.  
  65.     NAME
  66.         APIBriefClient - notify client
  67.  
  68.     SYNOPSIS
  69.         APIBriefClient(handle, apiMsg)
  70.  
  71.         void APIBriefClient(struct APIClient *, struct APIMessage *)
  72.                                  A0                      A1
  73.     FUNCTION
  74.         This function is called to pass commands to a client. The client
  75.         is expected to set the result slots of <apiMsg>.
  76.  
  77.     INPUTS
  78.         handle - handle obtained by APIMountClient()
  79.         apiMsg - API message
  80.  
  81.     RESULTS
  82.  
  83.     SEE ALSO
  84.  
  85.     BUGS
  86.  
  87. apilib.library/APIFree                    apilib.library/APIFree
  88.  
  89.     NAME
  90.         APIFree - free order data (V3)
  91.  
  92.     SYNOPSIS
  93.         APIFree(handle, struct APIOrder *);
  94.  
  95.         void APIFree(struct APIClient *, struct APIOrder *)
  96.                           A0                  A1
  97.     FUNCTION
  98.         This function is called after an order chain (passed from the
  99.         client to the host during a previous APIBriefClient call) has
  100.         been processed by the host. The client may now free resources
  101.         allocated for the orders.
  102.  
  103.     INPUTS
  104.         handle   - handle obtained by APIMountClient()
  105.         apiOrder - first API order structure
  106.  
  107.     RESULTS
  108.  
  109.     SEE ALSO
  110.  
  111.     BUGS
  112.